Document the "direction-changed" and "keys-changed" signals.
authorMatthias Clasen <maclas@gmx.de>
Tue, 30 Sep 2003 00:36:29 +0000 (00:36 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Tue, 30 Sep 2003 00:36:29 +0000 (00:36 +0000)
2003-09-30  Matthias Clasen  <maclas@gmx.de>

* gdk/gdkkeys.c (gdk_keymap_class_init): Document the
"direction-changed" and "keys-changed" signals.

* gdk/gdkscreen.c (gdk_screen_class_init): Document the
"size-changed" signal.

* gdk/gdkdisplaymanager.c (gdk_display_manager_class_init):
Document the "display-opened" signal.

* gdk/gdkdisplay.c (gdk_display_close): Doc tweak.
(gdk_display_class_init): Document the "closed" signal.

* gdk/tmpl/keys.sgml: Small addition.

* gdk/gdk-sections.txt: Add GdkDisplayClass and GdkScreenClass.

* gdk-pixbuf/gdk-pixbuf-sections.txt: Add GdkPixbufLoaderClass.

12 files changed:
ChangeLog
ChangeLog.pre-2-10
ChangeLog.pre-2-4
ChangeLog.pre-2-6
ChangeLog.pre-2-8
docs/reference/ChangeLog
docs/reference/gdk/gdk-sections.txt
docs/reference/gdk/tmpl/keys.sgml
gdk/gdkdisplay.c
gdk/gdkdisplaymanager.c
gdk/gdkkeys.c
gdk/gdkscreen.c

index 10dd4fec653477dd43607e5b6599f30006d0fc66..343c71dafef822d8ed3b73a50d46e3faa0263b3a 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,17 @@
+2003-09-30  Matthias Clasen  <maclas@gmx.de>
+
+       * gdk/gdkkeys.c (gdk_keymap_class_init): Document the
+       "direction-changed" and "keys-changed" signals.
+
+       * gdk/gdkscreen.c (gdk_screen_class_init): Document the 
+       "size-changed" signal.
+
+       * gdk/gdkdisplaymanager.c (gdk_display_manager_class_init): 
+       Document the "display-opened" signal.
+
+       * gdk/gdkdisplay.c (gdk_display_close): Doc tweak.
+       (gdk_display_class_init): Document the "closed" signal.
+
 Sat Sep 27 16:02:40 2003  Soeren Sandmann  <sandmann@daimi.au.dk>
 
        * gtk/gtktextview.[ch]: rename property tab_moves_focus to
index 10dd4fec653477dd43607e5b6599f30006d0fc66..343c71dafef822d8ed3b73a50d46e3faa0263b3a 100644 (file)
@@ -1,3 +1,17 @@
+2003-09-30  Matthias Clasen  <maclas@gmx.de>
+
+       * gdk/gdkkeys.c (gdk_keymap_class_init): Document the
+       "direction-changed" and "keys-changed" signals.
+
+       * gdk/gdkscreen.c (gdk_screen_class_init): Document the 
+       "size-changed" signal.
+
+       * gdk/gdkdisplaymanager.c (gdk_display_manager_class_init): 
+       Document the "display-opened" signal.
+
+       * gdk/gdkdisplay.c (gdk_display_close): Doc tweak.
+       (gdk_display_class_init): Document the "closed" signal.
+
 Sat Sep 27 16:02:40 2003  Soeren Sandmann  <sandmann@daimi.au.dk>
 
        * gtk/gtktextview.[ch]: rename property tab_moves_focus to
index 10dd4fec653477dd43607e5b6599f30006d0fc66..343c71dafef822d8ed3b73a50d46e3faa0263b3a 100644 (file)
@@ -1,3 +1,17 @@
+2003-09-30  Matthias Clasen  <maclas@gmx.de>
+
+       * gdk/gdkkeys.c (gdk_keymap_class_init): Document the
+       "direction-changed" and "keys-changed" signals.
+
+       * gdk/gdkscreen.c (gdk_screen_class_init): Document the 
+       "size-changed" signal.
+
+       * gdk/gdkdisplaymanager.c (gdk_display_manager_class_init): 
+       Document the "display-opened" signal.
+
+       * gdk/gdkdisplay.c (gdk_display_close): Doc tweak.
+       (gdk_display_class_init): Document the "closed" signal.
+
 Sat Sep 27 16:02:40 2003  Soeren Sandmann  <sandmann@daimi.au.dk>
 
        * gtk/gtktextview.[ch]: rename property tab_moves_focus to
index 10dd4fec653477dd43607e5b6599f30006d0fc66..343c71dafef822d8ed3b73a50d46e3faa0263b3a 100644 (file)
@@ -1,3 +1,17 @@
+2003-09-30  Matthias Clasen  <maclas@gmx.de>
+
+       * gdk/gdkkeys.c (gdk_keymap_class_init): Document the
+       "direction-changed" and "keys-changed" signals.
+
+       * gdk/gdkscreen.c (gdk_screen_class_init): Document the 
+       "size-changed" signal.
+
+       * gdk/gdkdisplaymanager.c (gdk_display_manager_class_init): 
+       Document the "display-opened" signal.
+
+       * gdk/gdkdisplay.c (gdk_display_close): Doc tweak.
+       (gdk_display_class_init): Document the "closed" signal.
+
 Sat Sep 27 16:02:40 2003  Soeren Sandmann  <sandmann@daimi.au.dk>
 
        * gtk/gtktextview.[ch]: rename property tab_moves_focus to
index 10dd4fec653477dd43607e5b6599f30006d0fc66..343c71dafef822d8ed3b73a50d46e3faa0263b3a 100644 (file)
@@ -1,3 +1,17 @@
+2003-09-30  Matthias Clasen  <maclas@gmx.de>
+
+       * gdk/gdkkeys.c (gdk_keymap_class_init): Document the
+       "direction-changed" and "keys-changed" signals.
+
+       * gdk/gdkscreen.c (gdk_screen_class_init): Document the 
+       "size-changed" signal.
+
+       * gdk/gdkdisplaymanager.c (gdk_display_manager_class_init): 
+       Document the "display-opened" signal.
+
+       * gdk/gdkdisplay.c (gdk_display_close): Doc tweak.
+       (gdk_display_class_init): Document the "closed" signal.
+
 Sat Sep 27 16:02:40 2003  Soeren Sandmann  <sandmann@daimi.au.dk>
 
        * gtk/gtktextview.[ch]: rename property tab_moves_focus to
index 22c0dc86c8c125d717e3f00688ed14229fb09e2f..dbfc1ac38d35eaf4bbf918c30991e905a1286613 100644 (file)
@@ -1,5 +1,9 @@
 2003-09-30  Matthias Clasen  <maclas@gmx.de>
 
+       * gdk/tmpl/keys.sgml: Small addition.
+
+       * gdk/gdk-sections.txt: Add GdkDisplayClass and GdkScreenClass.
+
        * gdk-pixbuf/gdk-pixbuf-sections.txt: Add GdkPixbufLoaderClass.
 
 2003-09-22  Matthias Clasen  <maclas@gmx.de>
index 3082aad420d88d4fe75548a1fcf114930508daac..a673b1e6cb4ac919f5e78461bf87bbe289fac111 100644 (file)
@@ -148,13 +148,14 @@ gdk_display_get_maximal_cursor_size
 GDK_DISPLAY_OBJECT
 GDK_IS_DISPLAY
 GDK_TYPE_DISPLAY
-gdk_display_get_type
 GDK_DISPLAY_CLASS
 GDK_IS_DISPLAY_CLASS
 GDK_DISPLAY_GET_CLASS
 
 <SUBSECTION Private>
 gdk_display_open_default_libgtk_only
+gdk_display_get_type
+GdkDisplayClass
 </SECTION>
 
 <SECTION>
@@ -208,10 +209,12 @@ gdk_screen_get_setting
 GDK_SCREEN
 GDK_IS_SCREEN
 GDK_TYPE_SCREEN
-gdk_screen_get_type
 GDK_SCREEN_CLASS
 GDK_IS_SCREEN_CLASS
 GDK_SCREEN_GET_CLASS
+<SUBSECTION Private>
+GdkScreenClass
+gdk_screen_get_type
 </SECTION>
 
 <SECTION>
index a42c2a99524d1daab7450b43bed2a1e8d5f8703c..f219a8336b1faeaf5bbec347b791b7fda2656b90 100644 (file)
@@ -30,8 +30,9 @@ Unicode characters with gdk_keyval_to_unicode() and gdk_unicode_to_keyval().
 </para>
 
 <para>
-One #GdkKeymap object exists for each user display. GTK 2 supports only one
-display, so gdk_keymap_get_default() returns the singleton #GdkKeymap.  A keymap
+One #GdkKeymap object exists for each user display. gdk_keymap_get_default() 
+returns the #GdkKeymap for the default display; to obtain keymaps for other 
+displays, use gdk_keymap_get_for_display(). A keymap
 is a mapping from #GdkKeymapKey to key values. You can think of a #GdkKeymapKey
 as a representation of a symbol printed on a physical keyboard key. That is, it
 contains three pieces of information. First, it contains the hardware keycode;
@@ -185,7 +186,7 @@ Returns the direction of the keymap.
 
 @keymap: a #GdkKeymap or %NULL to use the default keymap.
 Returns: %PANGO_DIRECTION_LTR or %PANGO_DIRECTION_RTL.
-@Returns: 
+@Returns: the direction of the keymap.
 
 
 <!-- ##### FUNCTION gdk_keyval_name ##### -->
index 49fb89be17d0f11c33c512f57561169658f2e75b..5dfeb77ec6478ed2707130919fb9517b0515249a 100644 (file)
@@ -121,6 +121,16 @@ gdk_display_class_init (GdkDisplayClass *class)
   object_class->finalize = gdk_display_finalize;
   object_class->dispose = gdk_display_dispose;
 
+  /**
+   * GdkDisplay::closed:
+   * @display: the object on which the signal is emitted
+   * @is_error: %TRUE if the display was closed due to an error
+   *
+   * The ::closed signal is emitted when the connection to the windowing
+   * system for @display is closed.
+   *
+   * Since: 2.2
+   */   
   signals[CLOSED] =
     g_signal_new ("closed",
                  G_OBJECT_CLASS_TYPE (object_class),
@@ -173,7 +183,7 @@ gdk_display_finalize (GObject *object)
  * gdk_display_close:
  * @display: a #GdkDisplay
  *
- * Closes the connection windowing system for the given display,
+ * Closes the connection to the windowing system for the given display,
  * and cleans up associated resources.
  *
  * Since: 2.2
index 5ca5ae23b3672a432c6a5541d9d5d621427255ed..7d7a7ad78ebd768addd2aa1548c979fd32f4c358 100644 (file)
@@ -100,6 +100,15 @@ gdk_display_manager_class_init (GdkDisplayManagerClass *klass)
   object_class->set_property = gdk_display_manager_set_property;
   object_class->get_property = gdk_display_manager_get_property;
 
+  /**
+   * GdkDisplayManager::display-opened:
+   * @display_manager: the object on which the signal is emitted
+   * @display: the opened display
+   *
+   * The ::display_opened signal is emitted when a display is opened.
+   *
+   * Since: 2.2
+   */
   signals[DISPLAY_OPENED] =
     g_signal_new ("display_opened",
                  G_OBJECT_CLASS_TYPE (object_class),
index 0ca76b86ea5c42443bbc1a073aab2f346b18688b..b6af0d5c53a89b63202c082af04b798c2e656d6e 100644 (file)
@@ -72,6 +72,15 @@ gdk_keymap_class_init (GdkKeymapClass *klass)
 {
   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 
+  /**
+   * GdkKeymap::direction-changed:
+   * @keymap: the object on which the signal is emitted
+   * 
+   * The ::direction_changed signal gets emitted when the direction of
+   * the keymap changes. 
+   *
+   * Since: 2.0
+   */
   signals[DIRECTION_CHANGED] =
     g_signal_new ("direction_changed",
                  G_OBJECT_CLASS_TYPE (object_class),
@@ -81,6 +90,15 @@ gdk_keymap_class_init (GdkKeymapClass *klass)
                  g_cclosure_marshal_VOID__VOID,
                  G_TYPE_NONE,
                  0);
+  /**
+   * GdkKeymap::keys-changed:
+   * @keymap: the object on which the signal is emitted
+   *
+   * The ::keys_changed signal is emitted when the mapping represented by
+   * @keymap changes.
+   *
+   * Since: 2.2
+   */
   signals[KEYS_CHANGED] =
     g_signal_new ("keys_changed",
                  G_OBJECT_CLASS_TYPE (object_class),
index 114dc49df223ab9d1771fe0a882cbd15e8d2ac95..0492ab2095a075817689c865d693abac457154b3 100644 (file)
@@ -67,6 +67,15 @@ gdk_screen_get_type (void)
 static void
 gdk_screen_class_init (GdkScreenClass *klass)
 {
+  /**
+   * GdkScreen::size-changed:
+   * @screen: the object on which the signal is emitted
+   * 
+   * The ::size_changed signal is emitted when the pixel width or 
+   * height of a screen changes.
+   *
+   * Since: 2.2
+   */
   signals[SIZE_CHANGED] =
     g_signal_new ("size_changed",
                   G_OBJECT_CLASS_TYPE (klass),